Copyright: MicroGate SyncLink WAN Monitor - Version 1.00
Citation: MicroGate SyncLink WAN Monitor - Version 1.00


MicroGate SyncLink WAN Monitor Help Index

Overview

MicroGate SyncLink WAN Monitor Overview

Virtual Modem Panel

Adapter Selection Window

Status Window

Adapter Status Window

LCP Status Window

IPCP Window

Menus and Commands

Snapshot

Options Menu

View menu

Help menu

Messages

Message List


MicroGate SyncLink WAN Monitor Overview

The MGWAN.EXE program enables and disables connections, displays adapter and connection status, and allows event and data tracing. The main program window is shown below:

Below the application’s menu bar and toolbar, is the Virtual Modem Panel which displays the serial signal status for the currently selected adapter.

The lower left window pane is the Adapter Selection Window, which selects the item for which status information is displayed. The items include adapters and the associated protocols running on an adapter (LCP, IPCP, IPXCP).

The lower right window pane is the Status Window, which displays the statistics for the selected item.


Virtual Modem Panel

The Virtual Modem Panel displays the current V.24 signals for the item selected in the Adapter Selection Window.

This panel mimics the front panel of a modem and provides feedback on the current connection signals for the selected view.

Listed below is a description of the various items composing the Virtual Modem Panel:

Mnemonic	V24 Signal Name	Input/Output	Description
DTR	Data Terminal Ready	Output	Activate when the adapter when ready to communicate.
DSR	Data Set Ready	Input	Active when the DCE is ready to communicate
RTS	Request To Send	Output	Activate when adapter needs to transmit.
CTS	Clear To Send	Input	Active when the DCE is ready for the adapter to transmit
TxD	Transmit Data	Output	Activate when transmitting data
DCD	Data Carrier Detect	Input	Active when the DCE has detected a connection from the remote.
RxD	Receive Data	Input	Active when receiving data
RI	Ring Indicator	Input	Active when then DCE is detecting an incoming call.

Note:

	inactive signal
	active signal


Adapter Selection Window

The adapter selection window displays a tree with all installed SyncLink adapters. Each adapter has three child items, with each item representing a protocol operating on the parent adapter. All items have an animated LED that can be one of four colors. The color indicates the status of the item as described below.

The adapter LED color is based on the PPP phase.

	Interface is disabled
	Dead phase
	Establish, Authenticate, or Terminate phase
	Network phase

The protocol (LCP,IPCP,IPXCP) LED color is based on the protocol state.

	Protocol is disabled
	Initial, Starting, Closed, or Stopped state
	Closing, Stopping, Request Sent, or Ack Received state
	Opened state

For more information on link phases and protocol states, see the PPP Overview.

Tree branches are expanded or compressed by clicking on [image] (expand) or [image] (compress).

Clicking on an item in the tree displays the status for that item in the Status Window.


Status Window

The status window displays the status of the item selected in the Adapter Status Window.

The different status items are:

 Adapter Status Window

 LCP Status Window

 IPCP Window


Adapter Status Window

This window displays current static Configuration information and dynamic Status information for the specified Adapter. Listed below is a description of the items available in this window:

Item	Value	Description
Trace File	{FileName}	If Tracing is enabled, {FileName} is the name of the current file being used to store trace information. If Tracing is not enabled, this field is blank.
Configuration
I/O Address	0xhhh	Hexadecimal value of the I/O Base Address configured for this Adapter. ISA adapter only.
IRQ	dd	Decimal value of the Interrupt Request Level configured for this Adapter. ISA adapter only.
DMA	dd	Decimal value of the DMA channel configured for this Adapter. ISA adapter only.
PCI Bus Number	dd	Decimal value of the PCI bus number (0-255) or Auto Detect. PCI adapter only.
PCI Device Number	dd	Decimal value of the PCI device number 0-31 or Auto Detect. PCI adapter only.
Status
Rx OK	ddddd	Number of frames received without error.
Rx Errors	ddddd	Number of frames received with errors.
Tx OK	ddddd	Number of send frames without errors.
Tx Errors	ddddd	Number of send frames with errors.
PPP Phase	Phase Name	Descriptive text for the PPP phase.
LCP State	State Name	Descriptive text for the LCP state.
IPCP State	State Name	Descriptive text for the IPCP state.
IPXCP State	State Name	Descriptive text for the IPXCP state.
Buttons
Enable/Disable Interface		Enables or disables the interface
Reset Current		Reset statistics for the selected item.
Start Trace / Stop Trace		Start/Stop tracing for the selected adapter.


Trace

The MicroGate SyncLink WAN Monitor allows you to trace activity on an adapter. This includes tracing data and events for all of the protocols associated with the specified Adapter.

The Trace Start Button

If tracing is not enabled for the particular Adapter, hitting the Trace Start button will bring up a file dialog box which allows you to specify the name of the file used to store the trace information.

After you select a file name, you will get the MicroGate SyncLink WAN Trace Options dialog, which allows you to select the type of information you wish to trace.

Once tracing is enabled, the Trace Start button changes to Trace Stop and the name of the file name is displayed in the Adapter status view.

Caution:

Enabling trace events should only be done as directed by MicroGate support engineers. By enabling tracing of data and/or events for diagnosing connection problems, you may experience some performance degradation due to the additional overhead of logging the items have specified.

The Trace Stop Button

If tracing is enabled for the particular Adapter, hitting the Trace Stop button will stop the current tracing activity and close the open trace file. Once tracing is disabled, the Trace Stop button changes to Trace Stop.


MicroGate SyncLink WAN Trace Options

Listed below is a description of the available trace options:

Check Boxes	Description
Data Trace	Enables tracing of transmitted and received frames.
Tx Events	Enables tracing of transmit events.
Rx Events	Enables tracing of receive events.
Status Events	Enables tracing of status events.
NDIS Events	Enables tracing of NDIS events.
PPP Events	Enables tracing of PPP events.
Buttons
	OK Button - enables tracing to the file previously specified using the current trace options enabled in the above check boxes.
	Cancel Button – cancels the trace activation - no trace is started.
	Clear All Button – clears all of the check boxes - disables all trace options.
	Set All Button - sets all of the check boxes - enables all trace options.
	Help Button - provides user help.


LCP Status Window

This windows displays the status of the Link Control Protocol (LCP). If the LCP state is OPENED then the negotiated LCP options are displayed for both the remote and local peer.

Item	Value	Description
LCP State	State Name	Descriptive text for protocol state.
MRU	dddd	The negotiated value of the Maximum Receive Unit size in bytes.
Authentication Protocol	PAP, CHAP, or None	The negotiated authentication protocol.
Magic Number	hhhhhhhh	32 bit hexadecimal random number used to detect loopback condition.
Protocol Field Compression	Yes or No	Yes if protocol field compression is negotiated
Address and Control Field Compression	Yes or No	Yes if address and control field compression is negotiated.


IPCP Window

This window displays the status of the Internet Protocol Control Protocol (IPCP). IPCP is used to negotiate IP transfer over the PPP link. If the IPCP state is OPENED then the negotiated IPCP options are displayed for both the remote and local peer.

Item	Value	Description
IPCP State	State Name	Descriptive text for protocol state
IP Address	ddd.ddd.ddd.ddd	The negotiated IP address


IPXCP Window

This window displays the status of the Internetworking Packet Exchange Protocol Control Protocol (IPXCP). IPXCP is used to negotiate IPX transfer over the PPP link. If the IPXCP state is OPENED then the negotiated IPXCP options are displayed for both the remote and local peer.

Item	Value	Description
IPXCP State	State Name	Descriptive text for protocol state
Network Number	hhhhhhhh	The negotiated 32 bit hexadecimal network number. This option is common to both the local and remote peer.
Node Address	hh-hh-hh-hh-hh-hh	Negotiated IPX node address
Compression	None or Protocol Name	If compression is negotiated then this is the name of the protocol, otherwise None is displayed.
Routing Protocol	None,RIP/SAP,NLSP	The negotiated routing protocol.


Options menu commands

The Options menu offers the following commands:

Snapshot	Save configuration and status of all adapters and protocols to a file.
Setup	Configure application options
Reset Current	Reset statistics for the selected item
Reset All	Reset statistics for all items
Exit	Exits the application


Snapshot
Snapshot (Options menu commands)

The Snapshot menu command saves configuration and statistics for all adapters and protocols to a file for future reference or diagnostic purposes.

Selecting this menu item displays a file selection window for specifying the file to hold the saved information.

Shortcuts
Mouse:	Click on the Snapshot button on the toolbar


Setup
Setup (Options menu commands)

This command sets options for the MGWAN application. The following options may be specified:

Setup Option	Description
Update Interval (ms)	Interval between checks for status updates (specified in milliseconds)
	Minimum Value:	50 ms
	Maximum Value:	3000 ms (3 seconds)
	Exits the setup menu and saves any changes made.
	Exits the setup menu and discards any changes made.
Shortcuts
Mouse:	Click on the Setup button on the toolbar
Keys	CTRL+S


Reset Current
Reset Current (Options menu commands)

This command resets the statistics for the current object.

Shortcuts
Mouse:	Click on the Reset Current push button in the object’s status window
Keys:	CTRL+R


Reset All
Reset All (Options menu commands)

This command resets the statistics for all objects.

Shortcuts
Mouse:	Click on the Reset All toolbar button
Keys:	CTRL+A


Exit
Exit (Options menu commands)

This command exits the MGWAN program.  You can also use the Close command on the application Control menu.

Shortcuts
Mouse:	Double-click the application's Control menu button.
Keys:	ALT+F4


View menu commands

The View menu offers the following commands:

Toolbar	Shows or hides the toolbar.
Status Bar	Shows or hides the status bar.


Toolbar command (View menu)

Use this command to display and hide the Toolbar, which includes buttons for some of the most common commands in MicroGate SyncLink WAN Monitor.  A check mark appears next to the menu item when the Toolbar is displayed.

See Toolbar for help on using the toolbar.


Toolbar

The toolbar is displayed across the top of the application window, below the menu bar.  The toolbar provides quick mouse access to many tools used in MicroGate SyncLink WAN Monitor,

To hide or display the Toolbar, choose Toolbar from the View menu (ALT, V, T).

Click	To
	Saves the current configuration and statistics for all configured Adapters, LCPs PVC.
	Setup runtime options available for the MicroGate SyncLink WAN Monitor application
	Reset the statistics for all currently configured objects.
	To display program information, version number and copyright
	Display help for clicked on buttons, menus and windows


Status Bar command (View menu)

Use this command to display and hide the Status Bar, which describes the action to be executed by the selected menu item or depressed toolbar button, and keyboard latch state. A check mark appears next to the menu item when the Status Bar is displayed.

See Status Bar for help on using the status bar.


Status Bar

The status bar is displayed at the bottom of the MicroGate SyncLink WAN Monitor window.  To display or hide the status bar, use the Status Bar command in the View menu.

The left area of the status bar describes actions of menu items as you use the arrow keys to navigate through menus.  This area similarly shows messages that describe the actions of toolbar buttons as you depress them, before releasing them.  If after viewing the description of the toolbar button command you wish not to execute the command, then release the mouse button while the pointer is off the toolbar button.


Message List

The MicroGate SyncLink WAN Monitor may return the following messages. Listed beside the message is a brief explanation.

Failed to open Status driver

The MicroGate SyncLink WAN Monitor application (MGWAN.EXE) was unable to open the required driver (MGWANTR.SYS). Ensure the driver is being loaded and check the Event Viewer logs for possible errors. This message is accompanied by more text relating to the specified error that occurred.

Failed to reset statistics for this view

Failed to reset statistics for all views

An error occurred while resetting the statistics for the current view in the status window. This message is accompanied by more text relating to the specified error that occurred.

Failure getting status for Adapter d

The operation to get the current status for the specified item failed. This message is accompanied by more text relating to the specified error that occurred.

{RegKeyName} registry value larger than buffer.

{RegKeyName} registry value is wrong type.

An error occurred during registry query.

Unable to get status for Adapter d

The operation to get the current status for the specified item  failed. This message may be generated when the information returned is incomplete. This may be the result of using incompatible versions of the adapter driver (MGWAN.SYS), trace driver (MGWANTR.SYS), or the MicroGate SyncLink WAN Monitor application (MGWAN.EXE). Ensure you are running with the latest versions of the listed drivers and applications.

Unable to start timer

An error occurred while starting a Windows Timer used for status window updates.


Help Menu Commands

The Help menu offers the following commands, which provide you assistance with this application:

Help Topics	Offers you an index to topics on which you can get help.
About	Displays the version number of this application.


Index command (Help menu)

Use this command to display the opening screen of Help.  From the opening screen, you can jump to step-by-step instructions for using MicroGate SyncLink WAN Monitor and various types of reference information.

Once you open Help, you can click the Contents button whenever you want to return to the opening screen.


Using Help command (Help menu)

Use this command for instructions about using Help.


About command (Help menu)

Use this command to display the copyright notice and version number of your copy of MicroGate SyncLink WAN Monitor.


Help Using Help Command
Context Help command

Use the Context Help command to obtain help on some portion of MicroGate SyncLink WAN Monitor.  When you choose the Toolbar's Context Help button, the mouse pointer will change to an arrow and question mark.  Then click somewhere in the MicroGate SyncLink WAN Monitor window, such as another Toolbar button.  The Help topic will be shown for the item you clicked.

Shortcuts
Keys:	SHIFT+F1


Title Bar

The title bar is located along the top of a window.  It contains the name of the application and document.

To move the window, drag the title bar.


Scroll bars

Displayed at the right and bottom edges of the document window.  The scroll boxes inside the scroll bars indicate your vertical and horizontal location in the document.  You can use the mouse to scroll to other parts of the view.


Size command (System menu)

Use this command to display a four-headed arrow so you can size the active window with the arrow keys.

After the pointer changes to the four-headed arrow:

1.	Press one of the DIRECTION keys (left, right, up, or down arrow key) to move the pointer to the border you want to move.

2.	Press a DIRECTION key to move the border.

3.	Press ENTER when the window is the size you want.

Note:  This command is unavailable if you maximize the window.

Shortcuts
Mouse:	Drag the size bars at the corners or edges of the window.


Move command (Control menu)

Use this command to display a four-headed arrow so you can move the active window or dialog box with the arrow keys.

Note:  This command is unavailable if you maximize the window.

Shortcuts
Keys:	CTRL+F7


System Minimize Command
Minimize command (application Control menu)

Use this command to reduce the MicroGate SyncLink WAN Monitor window to an icon.

Shortcuts
Mouse:	Click the minimize icon [image] on the title bar.
Keys:	ALT+F9


Maximize command (System menu)

Use this command to enlarge the active window to fill the available space.

Shortcuts
Mouse:	Click the maximize icon [image] on the title bar; or double-click the title bar.
Keys:	CTRL+F10 enlarges a document window.


Next Window command (document Control menu)

Use this command to switch to the next open document window.  MicroGate SyncLink WAN Monitor determines which window is next according to the order in which you opened the windows.

Shortcuts
Keys:	CTRL+F6


Previous Window command (document Control menu)

Use this command to switch to the previous open document window.  MicroGate SyncLink WAN Monitor determines which window is previous according to the order in which you opened the windows.

Shortcuts
Keys:	SHIFT+CTRL+F6


Close command (Control menus)

Use this command to close the active window or dialog box.

Double-clicking a Control-menu box is the same as choosing the Close command.

Note:  If you have multiple windows open for a single document, the Close command on the document Control menu closes only one window at a time.  You can close all windows at once with the Close command on the File menu.

Shortcuts
Keys:	CTRL+F4 closes a document window
	ALT+F4 closes the application.


Restore command (Control menu)

Use this command to return the active window to its size and position before you chose the Maximize or Minimize command.


Switch to command (application Control menu)

Use this command to display a list of all open applications.  Use this "Task List" to switch to or close an application on the list.

Shortcuts
Keys:	CTRL+ESC

Dialog Box Options

When you choose the Switch To command, you will be presented with a dialog box with the following options:

Task List

Select the application you want to switch to or close.

Switch To

Makes the selected application active.

End Task

Closes the selected application.

Cancel

Closes the Task List box.

Cascade

Arranges open applications so they overlap and you can see each title bar.  This option does not affect applications reduced to icons.

Tile

Arranges open applications into windows that do not overlap.  This option does not affect applications reduced to icons.

Arrange Icons

Arranges the icons of all minimized applications across the bottom of the screen.


No Help Available

No help is available for this area of the window.


No Help Available

No help is available for this message box.


DCE

Data Communications Equipment - normally the equipment to which the adapter is connected via modem cable. This has traditionally be an external modem, CSU/DSU, etc.


IP

Internet Protocol - a network protocol used on the Internet and Enterprise networks. The IP Address is a 32-bit value that consists of a network address and a host address. The portion of the IP address used by the network address is determined by the netmask.


IPX

Internetworking Packet Exchange - a network protocol used on Novell Networks. A complete IPX address consists of a 32-bit network number and a 48-bit node address which is the same as the MAC address.


MAC

Media Access Control - the 48-bit hardware address of the adapter.


Configuration Information
Configuration

These items are considered static and are configured during the installation of the Adapter in the Network Settings control panel application.

These items are not reset when the Reset Current button/command is hit.


Status Information
Status

These items are considered dynamic and are updated periodically (as specified by Update Interval in the Setup dialog box.

These items are reset when the Reset Current button/command is hit.


PPP Overview

The Point to Point Protocol (PPP) allows the exchange of network traffic over a point to point connection between two peers (routers or computers). Multiple network protocols can operate simultaneously over the PPP link. RFC1661 describes the PPP protocol in detail.

PPP is a family of protocols for controlling the link and negotiating protocol options. The Link Control Protocol (LCP) negotiates options for the physical link such as frame size, authentication and compression. Network Layer Protocols (IP and IPX) are controlled and configured by an associated Network Control Protocol (NCP). IP uses the Internet Protocol Control Protocol (IPCP) and the IPX protocol uses the Internetworking Packet Exchange Control Protocol (IPXCP).

Two authentication protocols support peer identification: the Password Authentication Protocol (PAP) and the Challenge Handshake Authentication Protocol (CHAP).

When all the protocols have successfully completed negotiation and authentication, then network traffic is exchanged over the PPP link.

PPP Link Phases

The PPP link has distinct phases of operation as described in the following sections.

Link Dead (physical-layer not ready)

The link begins and ends with this phase. When an external event (carrier detection) indicates that the physical-layer is ready, PPP proceeds to the Link Establishment phase. The link returns to this phase after disconnection (carrier loss or user disables interface).

Link Establishment Phase

The Link Control Protocol (LCP) establishes the link by exchanging LCP packets. When this exchange completes successfully, the link advances to the Authentication Phase if authentication is enabled or directly to the Network-Layer Protocol phase if authentication is disabled. Any non-LCP packets received during this phase are discarded.

Authentication Phase

One or both peers are authenticated using PAP or CHAP protocols. If authentication succeeds, the link advances to the Network-Layer Protocol phase. If authentication fails, the link proceeds to the Link Termination phase. Only LCP and authentication packets are allowed during this phase. All other received packets are discarded.

Network-Layer Protocol Phase

In this phase, each network-layer protocol (IP, IPX) is separately configured by the appropriate Network Control Protocol (NCP). After a NCP has reached the Opened state, PPP carries the corresponding network-layer protocol packets. Network-layer protocol packets received when the corresponding NCP is not in the Opened state are discarded. During this phase, link traffic consists of any possible combination of LCP, NCP, and network-layer protocol packets.

Link Termination Phase

PPP can terminate the link at any time. This might happen because of the loss of carrier, authentication failure, or the user disabling the link. LCP closes the link through an exchange of Terminate packets. Any non-LCP packets received during this phase are discarded.

Control Protocol Operation

The LCP and NCPs are similar protocols. Each protocol negotiates options by sending Configure-Request packets. If the peer accepts the request then it responds with a Configure-Ack (acknowledgement) packet. The negotiation completes successfully, and the protocol enters the Opened state, when both peers have sent Configure-Requests and received Configure-Acks. When a protocol is terminating, it sends a Terminate-Request packet and waits for a Terminate-Ack packet.

The hardware and control protocols are organized as layers such that higher layers request service from lower layers. As the lower layers become available, they signal the upper layers.

The NCPs are the highest layer. When the user enables the interface, the NCPs request service from the LCP which in turn requests service from the physical layer. When the physical layer becomes available (carrier detect), it signals the LCP to start negotiation. When the LCP enters the Opened state (negotiation complete) it signals the authentication protocols to start. When the authentication protocols complete, they signal the NCPs to start negotiation. When the NCPs complete negotiation then the link is completely active and network traffic can be exchanged.

The LCP and NCPs have the following operational states defined:

Initial

The lower layer is down, and no upper layer requires this layers services.

Starting

An upper layer has requested service from this layer, but the lower layer is down.

Closed

The lower layer is up, but no upper layer requires this layers services.

Stopped

This layer is down and has signaled the lower layer that it’s services are no longer needed. This layer is waiting for the lower layer to signal that the lower layer is down.

Closing

The upper layer no longer requires this layer’s services. A Terminate-Request has been sent, but a Terminate-Ack has not yet been received.

Stopping

A Terminate-Request has been sent, but a Terminate-Ack has not yet been received.

Request-Sent

A Configure-Request has been sent, but a Configure-Ack has not yet been received

nor has a Configure-Ack been sent.

Ack-Received

A Configure-Request has been sent and a Configure-Ack has been received. A Configure-Ack has not yet been sent.

Ack-Sent

Configure-Request and a Configure-Ack have both been sent, but a Configure-Ack has not yet been received.

Opened

In the Opened state, a Configure-Ack has been both sent and received.